Skip to content

Conversation

@pengying
Copy link
Contributor

@pengying pengying commented Jan 24, 2026

TL;DR

Updated the response schema for external accounts endpoint to use data instead of accounts as the property name.

What changed?

Changed the required property name in the external accounts API response from accounts to data. This affects the schema definition in the OpenAPI specification across multiple files:

  • mintlify/openapi.yaml
  • openapi.yaml
  • openapi/paths/platform/platform_external_accounts.yaml

How to test?

  1. Make a request to the external accounts endpoint
  2. Verify that the response contains a data array instead of an accounts array
  3. Ensure all client code that consumes this API is updated to reference the new property name

Why make this change?

This change standardizes the API response format to be consistent with other endpoints in the system that use data as the top-level property for array responses. This improves API consistency and makes client integration more predictable.

@greptile-apps
Copy link

greptile-apps bot commented Jan 24, 2026

Greptile Overview

Greptile Summary

This PR standardizes the response format for the GET /platform/external-accounts endpoint by renaming the accounts property to data. This change brings consistency with all other list endpoints in the API (customers, internal accounts, transactions, quotes, tokens) which already use data as the top-level array property.

Key changes:

  • Updated OpenAPI schema in source file openapi/paths/platform/platform_external_accounts.yaml
  • Regenerated bundled files openapi.yaml and mintlify/openapi.yaml to reflect the change
  • Both required property name and property definition changed from accounts to data

Breaking change consideration:
This is a breaking API change that will require client code updates. Any consumers of this endpoint currently accessing response.accounts will need to update to response.data. The PR description mentions this in the testing section but could be more explicit about the breaking nature of this change.

Confidence Score: 4/5

  • This PR is safe to merge from a code quality perspective, but introduces a breaking API change that requires coordination
  • The schema changes are technically correct and bring consistency to the API. The OpenAPI specification is properly updated in both source and generated files. However, this is a breaking change that will impact existing API consumers, requiring them to update their integration code from response.accounts to response.data. The score is 4/5 rather than 5/5 because the breaking nature warrants careful deployment planning and client notification.
  • No files require special attention - all changes are straightforward schema updates

Important Files Changed

Filename Overview
openapi/paths/platform/platform_external_accounts.yaml Renamed response property from accounts to data in GET endpoint to match API standards
openapi.yaml Generated bundle file updated with the data property change from source files
mintlify/openapi.yaml Generated bundle file updated with the data property change for Mintlify docs

Sequence Diagram

sequenceDiagram
    participant Client
    participant API as Grid API
    participant Schema as OpenAPI Schema
    
    Note over Client,Schema: Before Change (Inconsistent)
    Client->>API: GET /platform/external-accounts
    API->>Schema: Validate response schema
    Note over Schema: Response uses "accounts" property
    Schema-->>API: Schema validation
    API-->>Client: { "accounts": [...] }
    Note over Client: Inconsistent with other endpoints
    
    Note over Client,Schema: After Change (Consistent)
    Client->>API: GET /platform/external-accounts
    API->>Schema: Validate response schema
    Note over Schema: Response uses "data" property
    Schema-->>API: Schema validation
    API-->>Client: { "data": [...] }
    Note over Client: Now consistent with all other list endpoints
Loading

gcamata
gcamata previously approved these changes Jan 27, 2026
@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema branch from 7ff24cf to b515799 Compare January 27, 2026 01:29
@pengying pengying force-pushed the 01-24-feat_convert_single-value_enums_to_const_for_base_types branch from 836aded to b4541c7 Compare January 27, 2026 01:29
Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

b515799 is a pure rebase onto b4541c7. Approving based on @gcamata's previous approval of 7ff24cf.

Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

b515799 is a pure rebase onto b4541c7. Approving based on @gcamata's previous approval of 7ff24cf.

@pengying pengying changed the base branch from 01-24-feat_convert_single-value_enums_to_const_for_base_types to graphite-base/127 January 27, 2026 05:16
Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

b515799 is a pure rebase onto b4541c7. Approving based on @gcamata's previous approval of 7ff24cf.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema branch from b515799 to e11522c Compare January 27, 2026 05:17
Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e11522c is a pure rebase onto fc8dd03. Approving based on @gcamata's previous approval of 7ff24cf.

restamp-bot[bot]
restamp-bot bot previously approved these changes Jan 27, 2026
Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e11522c is a pure rebase onto fc8dd03. Approving based on @gcamata's previous approval of 7ff24cf.

@graphite-app graphite-app bot changed the base branch from graphite-base/127 to main January 27, 2026 05:17
@graphite-app graphite-app bot dismissed stale reviews from restamp-bot[bot] and gcamata January 27, 2026 05:17

The base branch was changed.

@pengying pengying force-pushed the 01-24-feat_flatten_lightningexternalaccountinfo_schema branch from e11522c to 1ccf581 Compare January 27, 2026 05:17
Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e11522c is a pure rebase onto fc8dd03. Approving based on @gcamata's previous approval of 7ff24cf.

Copy link

@restamp-bot restamp-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1ccf581 is a pure rebase onto fc8dd03. Approving based on @gcamata's previous approval of 7ff24cf.

@pengying pengying merged commit 10fa3eb into main Jan 27, 2026
7 checks passed
@pengying pengying deleted the 01-24-feat_flatten_lightningexternalaccountinfo_schema branch January 27, 2026 05:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants